/*
 *  CameraEventListener.java
 *  ARToolKit5
 *
 *  This file is part of ARToolKit.
 *
 *  ARToolKit is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  ARToolKit is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with ARToolKit.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  As a special exception, the copyright holders of this library give you
 *  permission to link this library with independent modules to produce an
 *  executable, regardless of the license terms of these independent modules, and to
 *  copy and distribute the resulting executable under terms of your choice,
 *  provided that you also meet, for each linked independent module, the terms and
 *  conditions of the license of that module. An independent module is a module
 *  which is neither derived from nor based on this library. If you modify this
 *  library, you may extend this exception to your version of the library, but you
 *  are not obligated to do so. If you do not wish to do so, delete this exception
 *  statement from your version.
 *
 *  Copyright 2015 Daqri, LLC.
 *  Copyright 2011-2015 ARToolworks, Inc.
 *
 *  Author(s): Julian Looser, Philip Lamb
 *
 */

package org.artoolkit.ar.base.camera;

/**
 * The CameraEventListener interface allows an observer to respond to events 
 * from a {@link CaptureCameraPreview}.
 */
public interface CameraEventListener {

	/**
	 * Called when the camera preview is started. The video dimensions and frame rate
	 * are passed through, along with information about the camera.
	 * @param width The width of the video image in pixels.
	 * @param height The height of the video image in pixels.
	 * @param rate The capture rate in frames per second.
	 * @param cameraIndex	Zero-based index of the camera in use. If only one camera is present, will be 0.
	 * @param cameraIsFrontFacing false if camera is rear-facing (the default) or true if camera is facing toward the user.
	 */
	public void cameraPreviewStarted(int width, int height, int rate, int cameraIndex, boolean cameraIsFrontFacing);
	
	/**
	 * Called when the camera preview has a new frame ready.
	 * @param frame A byte array from the camera, in the camera's capture format.
	 */
	public void cameraPreviewFrame(byte[] frame);
	
	/**
	 * Called when the capture preview is stopped. No new frames will be sent.
	 */
	public void cameraPreviewStopped();
	
}
